This repository has been archived by the owner on Jan 21, 2022. It is now read-only.
feat: provide a singleton Clerk instance as the the default export, a… #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…llow usage of a sub-api directly, make all options configurable in a consistent manner
colinclerk
approved these changes
Jan 30, 2021
SokratisVidros
approved these changes
Jan 30, 2021
| 2. ENV var (if applicable) | ||
| 3. default | ||
|
|
||
| #### httpOptions |
|
|
||
| The http client used by the sdk is [got](https://github.com/sindresorhus/got). | ||
|
|
||
| All resource operations are mounted as sub-APIs on a `Clerk` object and return promises that either resolve with their expected resource types or reject with the error types described below. | ||
| All resource operations are mounted as sub-APIs on a `Clerk` class and return promises that either resolve with their expected resource types or reject with the error types described below. |
There was a problem hiding this comment.
👍 Do we coin the term sub-APIs? I like it.
There was a problem hiding this comment.
Well, it is kind of deceiving.
It's not like we have a main api and sub-apis.
Trying to refer to a grouping of api operations for a particular resource.
Naming suggestions most welcome.
| ``` | ||
|
|
||
| The middleware will set the Clerk session on the request object as `req.session` and simply call the next firmware. | ||
| The middleware will set the Clerk session on the request object as `req.session` and simply call the next middleware. |
| @@ -1,9 +1,9 @@ | |||
| const { requireSession } = require('@clerk/clerk-sdk-node'); | |||
| import clerk, { requireSession } from '@clerk/clerk-sdk-node'; | |||
|
|
|||
| function handler(req, res) { | |||
| console.log('Session required'); | |||
There was a problem hiding this comment.
@yourtallness Can we fix or surpress these Github actions linting suggestions? They kind of get in the way during the PR review
There was a problem hiding this comment.
#truedat, will look into it
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…llow usage of a sub-api directly, make all options configurable in a consistent manner
@colinclerk @SokratisVidros Please read the updated README & examples for a better overview of the new proposed usage.
The intention, based on Colin's proposal, was to have 2 potential variants available for import:
@clerk/clerk-sdk-node- default export is a singleton instance, good for 95% of cases@clerk/clerk-sdk-node/instance- default export is the constructor, doesn't instantiate a singleton instanceNote: all other deps are exported by both modules so that you only need to import from one source.
Currently the second "manifest" is hindered by the apparent lack of support for multiple entries in tsdx. We'll have to figure out a workaround.
For the time being I'm also exporting the constructor in the first package, so that the developer can instantiate themselves using that.
P.S. The case or
Clerk.defaultis a non-issue after all, caused by the import of an ESM module in a CJS context.See usage with CJS in the README for more.